API Documentation
RenderContext.h
1 // RenderContext.h
3 //
5 
6 namespace nkGraphics
7 {
11  class DLL_GRAPHICS_EXPORT RenderContext
12  {
13  public :
14 
22  virtual ~RenderContext () ;
23 
24  // Getters
28  Texture* getBackBuffer () const ;
32  Texture* getDepthBuffer () const ;
36  Viewport* getViewport () const ;
44  int getContextWidth () const ;
48  int getContextHeight () const ;
52  bool isWindowFocused () const ;
60  bool getOwnsWindow () const ;
61 
62  // Setters
68  void setCompositor (Compositor* value) ;
74  void setOwnsWindow (bool value) ;
80  virtual void setGammaCorrected (bool value) = 0 ;
81 
85  virtual void initialize (nkWinUi::GraphicsWindow* window) = 0 ;
86 
90  virtual void swap () = 0 ;
91 
95  virtual void refreshBufferSize () = 0 ;
99  virtual void refreshViewportSize () ;
100  } ;
101 }
nkGraphics::RenderContext::refreshBufferSize
virtual void refreshBufferSize()=0
nkGraphics::RenderContext::getContextWidth
int getContextWidth() const
nkGraphics::RenderContext::initialize
virtual void initialize(nkWinUi::GraphicsWindow *window)=0
nkGraphics::Texture
A texture used for rendering, hosted on GPU.
Definition: Texture.h:35
nkGraphics::RenderContext::setOwnsWindow
void setOwnsWindow(bool value)
nkGraphics::Viewport
Holds all the information needed about a viewport.
Definition: Viewport.h:12
nkGraphics::Compositor
A compositor, describing how to compose the rendering pipeline.
Definition: Compositor.h:21
nkGraphics::RenderContext::getViewport
Viewport * getViewport() const
nkGraphics::RenderContext::refreshViewportSize
virtual void refreshViewportSize()
nkGraphics::RenderContext
A rendering context, attached to a graphic window to present to the screen.
Definition: RenderContext.h:12
nkGraphics::RenderContext::RenderContext
RenderContext()
nkGraphics::RenderContext::getContextHeight
int getContextHeight() const
nkGraphics::RenderContext::isWindowFocused
bool isWindowFocused() const
nkGraphics::RenderContext::swap
virtual void swap()=0
nkGraphics::RenderContext::getBackBuffer
Texture * getBackBuffer() const
nkGraphics::RenderContext::getCompositor
Compositor * getCompositor() const
nkGraphics::RenderContext::getOwnsWindow
bool getOwnsWindow() const
nkGraphics::RenderContext::setGammaCorrected
virtual void setGammaCorrected(bool value)=0
nkGraphics::RenderContext::getDepthBuffer
Texture * getDepthBuffer() const
nkGraphics::RenderContext::getAttachedWin
nkWinUi::GraphicsWindow * getAttachedWin() const
nkWinUi::GraphicsWindow
A graphical window made to receive 3d rendering contexts.
Definition: GraphicsWindow.h:14
nkGraphics
Encompasses all API of component NilkinsGraphics.
Definition: BoundingBox.h:7
nkGraphics::RenderContext::setCompositor
void setCompositor(Compositor *value)
nkGraphics::RenderContext::~RenderContext
virtual ~RenderContext()